Foundry API

<back to all web services

ReportMachineStatusRequest

Requires Authentication
The following routes are available for this service:
All Verbs/machines/{Id}/statuses
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

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"id":"String","component":"String","code":"String","errorCode":"String","errorDetails":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":{"component":"String","code":"String","errorCode":"String","errorDetails":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}