Field Squared API Services

<back to all web services

StatusCheck

Check on Status of Long Running Services

The following routes are available for this service:
GET/{Workspace}/StatusCheck/{Id}
GET/{Workspace}/StatusCheck
namespace Field2Office.API.Model.StatusCheck

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

    [<AllowNullLiteral>]
    type StatusCheckItem() = 
        member val RuleId:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Status:String = null with get,set
        member val PercentComplete:String = null with get,set
        member val LastUpdated:String = null with get,set

    ///<summary>
    ///Check on Status of Long Running Services
    ///</summary>
    [<AllowNullLiteral>]
    type StatusCheck() = 
        member val Workspace:String = null with get,set
        member val Id:String = null with get,set
        member val Items:ResizeArray<StatusCheckItem> = new ResizeArray<StatusCheckItem>() with get,set

F# StatusCheck 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.

GET /{Workspace}/StatusCheck/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml