tvpl.api

UpdateStepStatusRequest

The following routes are available for this service:
POST	/WorkflowStep/status

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStepResponse(IResponseRequest):
    code: int = 0
    message: Optional[str] = None
    inserted_id: int = 0


class CategoryStatusKeys(str, Enum):
    WORK_CREATED = 'WorkCreated'
    WORK_IN_PROGRESS = 'WorkInProgress'
    WORK_RETURNED = 'WorkReturned'
    WORK_COMPLETED = 'WorkCompleted'
    WORK_CANCELLED = 'WorkCancelled'
    WORK_DONE = 'WorkDone'
    STEP_NOT_STARTED = 'StepNotStarted'
    STEP_IN_PROGRESS = 'StepInProgress'
    STEP_DONE = 'StepDone'
    STEP_COMPLETED = 'StepCompleted'
    STEP_SKIPPED = 'StepSkipped'
    STEP_RETURNED = 'StepReturned'
    NOT_SIGNED = 'NotSigned'
    SIGNATURE_RETURNED = 'SignatureReturned'
    SIGNATURE_PENDING = 'SignaturePending'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateStepStatusRequest:
    step_id: int = 0
    status_key: Optional[CategoryStatusKeys] = None
    comment: Optional[str] = None

Python 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>