sfgboxapi

<back to all web services

SystemEntitiesById

Requires Authentication
The following routes are available for this service:
GET/system_entities/{Id}
import 'package:servicestack/servicestack.dart';

class SystemEntitiesByIdResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? id;

    // @DataMember(Order=5)
    ResponseStatus? responseStatus;

    SystemEntitiesByIdResponse({this.id,this.responseStatus});
    SystemEntitiesByIdResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class SystemEntitiesById implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? id;

    SystemEntitiesById({this.id});
    SystemEntitiesById.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id
    };

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

TypeContext _ctx = TypeContext(library: 'sfgboxapi.dev.scadsoftware.com', types: <String, TypeInfo> {
    'SystemEntitiesByIdResponse': TypeInfo(TypeOf.Class, create:() => SystemEntitiesByIdResponse()),
    'SystemEntitiesById': TypeInfo(TypeOf.Class, create:() => SystemEntitiesById()),
});

Dart SystemEntitiesById 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.

GET /system_entities/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}