Trendsic Platform Service

<back to all web services

PlanSetStatusRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/plansets/{PlanSetUID}/status
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class PlanSetStatusResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    String? PlanSetUID;
    String? Status;
    int? Progress;
    int? PageCount;
    int? SheetCount;
    String? ErrorText;
    String? StageLabel;

    PlanSetStatusResponse({this.ResponseStatus,this.PlanSetUID,this.Status,this.Progress,this.PageCount,this.SheetCount,this.ErrorText,this.StageLabel});
    PlanSetStatusResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        PlanSetUID = json['PlanSetUID'];
        Status = json['Status'];
        Progress = json['Progress'];
        PageCount = json['PageCount'];
        SheetCount = json['SheetCount'];
        ErrorText = json['ErrorText'];
        StageLabel = json['StageLabel'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'PlanSetUID': PlanSetUID,
        'Status': Status,
        'Progress': Progress,
        'PageCount': PageCount,
        'SheetCount': SheetCount,
        'ErrorText': ErrorText,
        'StageLabel': StageLabel
    };

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

class PlanSetStatusRequest implements IConvertible
{
    String? PlanSetUID;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'PlanSetStatusResponse': TypeInfo(TypeOf.Class, create:() => PlanSetStatusResponse()),
    'PlanSetStatusRequest': TypeInfo(TypeOf.Class, create:() => PlanSetStatusRequest()),
});

Dart PlanSetStatusRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/plansets/{PlanSetUID}/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	PlanSetUID: 00000000000000000000000000000000,
	Status: String,
	Progress: 0,
	PageCount: 0,
	SheetCount: 0,
	ErrorText: String,
	StageLabel: String
}