tvpl.api

<back to all web services

SubmitWorkflowDeleteRequest

Requires Authentication
The following routes are available for this service:
POST/workflow/{WorkflowId}/delete-request
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using tvpl.api.ServiceModel;
using tvpl.data.Models;

namespace tvpl.api.ServiceModel
{
    public partial class SubmitWorkflowDeleteRequest
    {
        public virtual int WorkflowId { get; set; }
        public virtual string Reason { get; set; }
    }

    public partial class WorkflowDeleteRequestDetail
    {
        public virtual int Id { get; set; }
        public virtual int WorkflowId { get; set; }
        public virtual int RequestedBy { get; set; }
        public virtual string RequestedByName { get; set; }
        public virtual int ApproverId { get; set; }
        public virtual string ApproverName { get; set; }
        public virtual WorkflowDeleteRequestStatus Status { get; set; }
        public virtual string Reason { get; set; }
        public virtual string Comment { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual DateTime? ActionAt { get; set; }
    }

    public partial class WorkflowDeleteRequestResponse
    {
        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
        public virtual bool RequiresApproval { get; set; }
        public virtual WorkflowDeleteRequestDetail Request { get; set; }
    }

}

namespace tvpl.data.Models
{
    public enum WorkflowDeleteRequestStatus
    {
        Pending,
        Approved,
        Rejected,
        Cancelled,
    }

}

C# SubmitWorkflowDeleteRequest 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.

POST /workflow/{WorkflowId}/delete-request HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	workflowId: 0,
	reason: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	requiresApproval: False,
	request: 
	{
		id: 0,
		workflowId: 0,
		requestedBy: 0,
		requestedByName: String,
		approverId: 0,
		approverName: String,
		status: Pending,
		reason: String,
		comment: String,
		actionAt: "0001-01-01T00:00:00.0000000+07:06"
	}
}