tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
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

    [<AllowNullLiteral>]
    type BasicUploadedFile() = 
        member val FileName:String = null with get,set
        member val Filekey:String = null with get,set
        member val FileUrl:String = null with get,set
        member val Checksum:String = null with get,set
        member val ETag:String = null with get,set
        member val FileSize:Int64 = new Int64() with get,set

    [<AllowNullLiteral>]
    type UploadedFiles() = 
        inherit BasicUploadedFile()
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val UploadedFile:String = null with get,set
        member val SubDocumentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StepId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Code:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BasicSignerConfig() = 
        member val SubDocumentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DepartmentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SignerType:Byte = new Byte() with get,set
        member val SignerRefId:Int32 = new Int32() with get,set
        [<Ignore>]
        member val SignerRefText:String = null with get,set

        member val ActionType:Byte = new Byte() with get,set
        member val OrderIndex:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SignerConfig() = 
        inherit BasicSignerConfig()
        member val Id:Int32 = new Int32() with get,set
        member val DocumentId:Int32 = new Int32() with get,set
        member val StepId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type WorkFlowProfile() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val FullName:String = null with get,set
        member val Email:String = null with get,set
        member val DepartmentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Avatar:String = null with get,set
        member val Telephone:String = null with get,set
        member val Birthday:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ConfirmStatus:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ConfirmStatusText:String = null with get,set
        member val SignAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SignedFileId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val OriginalFileId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SignedFileName:String = null with get,set
        member val IsSigned:Boolean = new Boolean() with get,set
        member val SignStatusText:String = null with get,set

    [<AllowNullLiteral>]
    type Roles() = 
        member val Id:Int32 = new Int32() with get,set
        [<StringLength(50)>]
        member val Name:String = null with get,set

        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DeletedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<Ignore>]
        member val Permission:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type SignerConfigDetail() = 
        inherit SignerConfig()
        member val Profile:WorkFlowProfile = null with get,set
        member val Role:Roles = null with get,set

    [<AllowNullLiteral>]
    type StepAttached() = 
        member val Id:Int32 = new Int32() with get,set
        member val DocumentCode:String = null with get,set
        member val Title:String = null with get,set
        member val IsSequentialSigning:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val PendingSignFile:UploadedFiles = null with get,set
        member val OriginalFile:UploadedFiles = null with get,set
        member val SignerConfigs:ResizeArray<SignerConfigDetail> = new ResizeArray<SignerConfigDetail>() with get,set

    [<AllowNullLiteral>]
    type WorkflowStep() = 
        member val Id:Int32 = new Int32() with get,set
        [<References(typeof<Document>)>]
        member val WorkflowId:Int32 = new Int32() with get,set

        member val StepOrder:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StatusId:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<Required>]
        [<StringLength(255)>]
        member val StepName:String = null with get,set

        [<Required>]
        member val IsRequired:Boolean = new Boolean() with get,set

        member val SLALegalValue:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SLALegalIsByDay:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val SLAInternalValue:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SLAInternalIsByDay:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val RequireAttachment:Boolean = new Boolean() with get,set
        member val IsUsingForm:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        [<Required>]
        member val Description:String = null with get,set

        member val CreatedBy:Int32 = new Int32() with get,set
        [<Ignore>]
        member val DepartmentIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        [<Ignore>]
        member val MainAssigneeIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        [<Ignore>]
        member val CoDepartmentIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        [<Ignore>]
        member val SupportingAssigneeIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        [<Ignore>]
        member val StepBasisDocumentIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        [<Ignore>]
        member val AttachedDocuments:ResizeArray<StepAttached> = new ResizeArray<StepAttached>() with get,set

    [<AllowNullLiteral>]
    type CreateWorkflowStepRequest() = 
        inherit WorkflowStep()

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

<CreateWorkflowStepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <AttachedDocuments xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <StepAttached>
      <DocumentCode>String</DocumentCode>
      <Id>0</Id>
      <IsSequentialSigning>false</IsSequentialSigning>
      <OriginalFile>
        <Checksum>String</Checksum>
        <ETag>String</ETag>
        <FileName>String</FileName>
        <FileSize>0</FileSize>
        <FileUrl>String</FileUrl>
        <Filekey>String</Filekey>
        <Code>0</Code>
        <Id>0</Id>
        <StepId>0</StepId>
        <SubDocumentId>0</SubDocumentId>
        <UploadedFile>String</UploadedFile>
      </OriginalFile>
      <PendingSignFile>
        <Checksum>String</Checksum>
        <ETag>String</ETag>
        <FileName>String</FileName>
        <FileSize>0</FileSize>
        <FileUrl>String</FileUrl>
        <Filekey>String</Filekey>
        <Code>0</Code>
        <Id>0</Id>
        <StepId>0</StepId>
        <SubDocumentId>0</SubDocumentId>
        <UploadedFile>String</UploadedFile>
      </PendingSignFile>
      <SignerConfigs>
        <SignerConfigDetail>
          <ActionType>0</ActionType>
          <DepartmentId>0</DepartmentId>
          <OrderIndex>0</OrderIndex>
          <SignerRefId>0</SignerRefId>
          <SignerRefText>String</SignerRefText>
          <SignerType>0</SignerType>
          <SubDocumentId>0</SubDocumentId>
          <CreateAt>0001-01-01T00:00:00</CreateAt>
          <CreateBy>0</CreateBy>
          <DocumentId>0</DocumentId>
          <Id>0</Id>
          <StepId>0</StepId>
          <Profile>
            <Avatar>String</Avatar>
            <Birthday>0001-01-01T00:00:00</Birthday>
            <ConfirmStatus>0</ConfirmStatus>
            <ConfirmStatusText>String</ConfirmStatusText>
            <DepartmentId>0</DepartmentId>
            <Email>String</Email>
            <FullName>String</FullName>
            <Id>0</Id>
            <IsSigned>false</IsSigned>
            <Name>String</Name>
            <OriginalFileId>0</OriginalFileId>
            <SignAt>0001-01-01T00:00:00</SignAt>
            <SignStatusText>String</SignStatusText>
            <SignedFileId>0</SignedFileId>
            <SignedFileName>String</SignedFileName>
            <Telephone>String</Telephone>
          </Profile>
          <Role>
            <CreatedAt>0001-01-01T00:00:00</CreatedAt>
            <CreatedBy>0</CreatedBy>
            <DeletedAt>0001-01-01T00:00:00</DeletedAt>
            <DeletedBy>0</DeletedBy>
            <Id>0</Id>
            <Name>String</Name>
            <Permission xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </Permission>
            <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
            <UpdatedBy>0</UpdatedBy>
          </Role>
        </SignerConfigDetail>
      </SignerConfigs>
      <Title>String</Title>
    </StepAttached>
  </AttachedDocuments>
  <CoDepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </CoDepartmentIds>
  <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</CreatedBy>
  <DeletedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</DeletedAt>
  <DeletedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</DeletedBy>
  <DepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </DepartmentIds>
  <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
  <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
  <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
  <IsUsingForm xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsUsingForm>
  <MainAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </MainAssigneeIds>
  <RequireAttachment xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</RequireAttachment>
  <SLAInternalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLAInternalIsByDay>
  <SLAInternalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAInternalValue>
  <SLALegalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLALegalIsByDay>
  <SLALegalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLALegalValue>
  <SLAWarningSentAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</SLAWarningSentAt>
  <SLAWarningSentCount xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAWarningSentCount>
  <StatusId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StatusId>
  <StepBasisDocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </StepBasisDocumentIds>
  <StepName xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</StepName>
  <StepOrder xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StepOrder>
  <SupportingAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </SupportingAssigneeIds>
  <UpdatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</UpdatedBy>
  <WorkflowId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</WorkflowId>
</CreateWorkflowStepRequest>

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>