Foundry API

<back to all web services

ReportMachineStatusRequest

Requires Authentication
The following routes are available for this service:
All Verbs/machines/{Id}/statuses
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MachineStatus() = 
        member val Component:String = null with get,set
        member val ObservedAt:DateTime = new DateTime() with get,set
        member val Code:String = null with get,set
        member val ErrorCode:String = null with get,set
        member val ErrorDetails:String = null with get,set

    [<AllowNullLiteral>]
    type ReportMachineStatusResponse() = 
        member val Status:MachineStatus = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ReportMachineStatusRequest() = 
        inherit PostOperationTenanted<ReportMachineStatusResponse>()
        member val Id:String = null with get,set
        member val Component:String = null with get,set
        member val ObservedAt:DateTime = new DateTime() with get,set
        member val Code:String = null with get,set
        member val ErrorCode:String = null with get,set
        member val ErrorDetails:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationTenanted<'TResponse>() = 
        inherit PostOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# ReportMachineStatusRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","component":"String","code":"String","errorCode":"String","errorDetails":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}