tvpl.api

<back to all web services

UpdateStepStatusRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/status
import Foundation
import ServiceStack

public class UpdateStepStatusRequest : Codable
{
    public var stepId:Int
    public var statusKey:CategoryStatusKeys
    public var comment:String

    required public init(){}
}

public enum CategoryStatusKeys : String, Codable
{
    case WorkCreated
    case WorkInProgress
    case WorkReturned
    case WorkCompleted
    case WorkCancelled
    case WorkDone
    case StepNotStarted
    case StepInProgress
    case StepDone
    case StepCompleted
    case StepSkipped
    case StepReturned
    case NotSigned
    case SignatureReturned
    case SignaturePending
    case DocExpired
    case DocPartiallyEx
}

public class WorkflowStepResponse : IResponseRequest, Codable
{
    public var code:Int
    public var message:String
    public var insertedId:Int

    required public init(){}
}

Swift 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}