Foundry API

<back to all web services

ReportMachineStatusRequest

import Foundation
import ServiceStack

public class ReportMachineStatusRequest : PostOperationTenanted<ReportMachineStatusResponse>
{
    public var id:String?
    public var component:String?
    public var observedAt:Date?
    public var code:String?
    public var errorCode:String?
    public var errorDetails:String?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case component
        case observedAt
        case code
        case errorCode
        case errorDetails
    }

    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)
        component = try container.decodeIfPresent(String.self, forKey: .component)
        observedAt = try container.decodeIfPresent(Date.self, forKey: .observedAt)
        code = try container.decodeIfPresent(String.self, forKey: .code)
        errorCode = try container.decodeIfPresent(String.self, forKey: .errorCode)
        errorDetails = try container.decodeIfPresent(String.self, forKey: .errorDetails)
    }

    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 component != nil { try container.encode(component, forKey: .component) }
        if observedAt != nil { try container.encode(observedAt, forKey: .observedAt) }
        if code != nil { try container.encode(code, forKey: .code) }
        if errorCode != nil { try container.encode(errorCode, forKey: .errorCode) }
        if errorDetails != nil { try container.encode(errorDetails, forKey: .errorDetails) }
    }
}

public class PostOperationTenanted<TResponse : Codable> : PostOperationUnTenanted<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 PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class ReportMachineStatusResponse : Codable
{
    public var status:MachineStatus?
    public var responseStatus:ResponseStatus?

    required public init(){}
}

public class MachineStatus : Codable
{
    public var component:String?
    public var observedAt:Date?
    public var code:String?
    public var errorCode:String?
    public var errorDetails:String?

    required public init(){}
}

Swift ReportMachineStatusRequest DTOs

POST /machines/{Id}/statuses HTTP/1.1 
Host: staging-api.foundrylab.com 
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>