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
}

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 .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 /WorkflowStep/status HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateStepStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Comment>String</Comment>
  <StatusKey>WorkCreated</StatusKey>
  <StepId>0</StepId>
</UpdateStepStatusRequest>

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

<WorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
</WorkflowStepResponse>