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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.StatusCheck

Namespace Global

    Namespace Field2Office.API.Model.StatusCheck

        '''<Summary>
        '''Check on Status of Long Running Services
        '''</Summary>
        Public Partial Class StatusCheck
            Public Sub New()
                Items = New List(Of StatusCheckItem)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Id As String
            Public Overridable Property Items As List(Of StatusCheckItem)
        End Class

        Public Partial Class StatusCheckItem
            Public Overridable Property RuleId As String
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Status As String
            Public Overridable Property PercentComplete As String
            Public Overridable Property LastUpdated As String
        End Class
    End Namespace
End Namespace

VB.NET 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