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
import 'package:servicestack/servicestack.dart';

class StatusCheckItem implements IConvertible
{
    String? RuleId;
    String? Name;
    String? Description;
    String? Status;
    String? PercentComplete;
    String? LastUpdated;

    StatusCheckItem({this.RuleId,this.Name,this.Description,this.Status,this.PercentComplete,this.LastUpdated});
    StatusCheckItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RuleId = json['RuleId'];
        Name = json['Name'];
        Description = json['Description'];
        Status = json['Status'];
        PercentComplete = json['PercentComplete'];
        LastUpdated = json['LastUpdated'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RuleId': RuleId,
        'Name': Name,
        'Description': Description,
        'Status': Status,
        'PercentComplete': PercentComplete,
        'LastUpdated': LastUpdated
    };

    getTypeName() => "StatusCheckItem";
    TypeContext? context = _ctx;
}

/**
* Check on Status of Long Running Services
*/
class StatusCheck implements IConvertible
{
    String? Workspace;
    String? Id;
    List<StatusCheckItem>? Items;

    StatusCheck({this.Workspace,this.Id,this.Items});
    StatusCheck.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        Id = json['Id'];
        Items = JsonConverters.fromJson(json['Items'],'List<StatusCheckItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'Id': Id,
        'Items': JsonConverters.toJson(Items,'List<StatusCheckItem>',context!)
    };

    getTypeName() => "StatusCheck";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'StatusCheckItem': TypeInfo(TypeOf.Class, create:() => StatusCheckItem()),
    'StatusCheck': TypeInfo(TypeOf.Class, create:() => StatusCheck()),
    'List<StatusCheckItem>': TypeInfo(TypeOf.Class, create:() => <StatusCheckItem>[]),
});

Dart 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