tvpl.api

SubmitWorkflowDeleteRequest

The following routes are available for this service:
POST	/workflow/{WorkflowId}/delete-request

import Foundation
import ServiceStack

public class SubmitWorkflowDeleteRequest : Codable
{
    public var workflowId:Int
    public var reason:String

    required public init(){}
}

public class WorkflowDeleteRequestResponse : Codable
{
    public var code:Int
    public var message:String
    public var requiresApproval:Bool
    public var request:WorkflowDeleteRequestDetail

    required public init(){}
}

public class WorkflowDeleteRequestDetail : Codable
{
    public var id:Int
    public var workflowId:Int
    public var requestedBy:Int
    public var requestedByName:String
    public var approverId:Int
    public var approverName:String
    public var status:WorkflowDeleteRequestStatus
    public var reason:String
    public var comment:String
    public var createdAt:Date
    public var actionAt:Date?

    required public init(){}
}

public enum WorkflowDeleteRequestStatus : String, Codable
{
    case Pending
    case Approved
    case Rejected
    case Cancelled
}

Swift SubmitWorkflowDeleteRequest 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.

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

<SubmitWorkflowDeleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Reason>String</Reason>
  <WorkflowId>0</WorkflowId>
</SubmitWorkflowDeleteRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowDeleteRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Message>String</Message>
  <Request>
    <ActionAt>0001-01-01T00:00:00</ActionAt>
    <ApproverId>0</ApproverId>
    <ApproverName>String</ApproverName>
    <Comment>String</Comment>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <Id>0</Id>
    <Reason>String</Reason>
    <RequestedBy>0</RequestedBy>
    <RequestedByName>String</RequestedByName>
    <Status>Pending</Status>
    <WorkflowId>0</WorkflowId>
  </Request>
  <RequiresApproval>false</RequiresApproval>
</WorkflowDeleteRequestResponse>