tvpl.api

<back to all web services

UpdateStepStatusRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/status
namespace tvpl.api.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowStepResponse() = 
        member val Code:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val InsertedId:Int32 = new Int32() with get,set

    type CategoryStatusKeys =
        | WorkCreated = 0
        | WorkInProgress = 1
        | WorkReturned = 2
        | WorkCompleted = 3
        | WorkCancelled = 4
        | WorkDone = 5
        | StepNotStarted = 6
        | StepInProgress = 7
        | StepDone = 8
        | StepCompleted = 9
        | StepSkipped = 10
        | StepReturned = 11
        | NotSigned = 12
        | SignatureReturned = 13
        | SignaturePending = 14

    [<AllowNullLiteral>]
    type UpdateStepStatusRequest() = 
        member val StepId:Int32 = new Int32() with get,set
        member val StatusKey:CategoryStatusKeys = new CategoryStatusKeys() with get,set
        member val Comment:String = null with get,set

F# 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>