tvpl.api

<back to all web services

UpdateStepStatusRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/status
import 'package:servicestack/servicestack.dart';

class WorkflowStepResponse implements IResponseRequest, IConvertible
{
    int? code;
    String? message;
    int? insertedId;

    WorkflowStepResponse({this.code,this.message,this.insertedId});
    WorkflowStepResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'code': code,
        'message': message,
        'insertedId': insertedId
    };

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

enum CategoryStatusKeys
{
    WorkCreated,
    WorkInProgress,
    WorkReturned,
    WorkCompleted,
    WorkCancelled,
    WorkDone,
    StepNotStarted,
    StepInProgress,
    StepDone,
    StepCompleted,
    StepSkipped,
    StepReturned,
    NotSigned,
    SignatureReturned,
    SignaturePending,
}

class UpdateStepStatusRequest implements IConvertible
{
    int? stepId;
    CategoryStatusKeys? statusKey;
    String? comment;

    UpdateStepStatusRequest({this.stepId,this.statusKey,this.comment});
    UpdateStepStatusRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        stepId = json['stepId'];
        statusKey = JsonConverters.fromJson(json['statusKey'],'CategoryStatusKeys',context!);
        comment = json['comment'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'stepId': stepId,
        'statusKey': JsonConverters.toJson(statusKey,'CategoryStatusKeys',context!),
        'comment': comment
    };

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

TypeContext _ctx = TypeContext(library: 'etc_api.vsmlab.vn', types: <String, TypeInfo> {
    'WorkflowStepResponse': TypeInfo(TypeOf.Class, create:() => WorkflowStepResponse()),
    'CategoryStatusKeys': TypeInfo(TypeOf.Enum, enumValues:CategoryStatusKeys.values),
    'UpdateStepStatusRequest': TypeInfo(TypeOf.Class, create:() => UpdateStepStatusRequest()),
});

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

POST /WorkflowStep/status HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"stepId":0,"statusKey":"WorkCreated","comment":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"code":0,"message":"String","insertedId":0}