tvpl.api

<back to all web services

CreateWorkflowStepRequest

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

public class CreateWorkflowStepRequest : WorkflowStep
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class WorkflowStep : Codable
{
    public var id:Int
    // @References(typeof(Document))
    public var workflowId:Int

    public var stepOrder:Int?
    public var statusId:Int?
    // @Required()
    // @StringLength(255)
    public var stepName:String?

    // @Required()
    public var isRequired:Bool?

    public var slaLegalValue:Int?
    public var slaLegalIsByDay:Bool?
    public var slaInternalValue:Int?
    public var slaInternalIsByDay:Bool?
    public var requireAttachment:Bool
    public var isUsingForm:Bool?
    // @Required()
    public var Description:String?

    public var createdBy:Int
    // @Ignore()
    public var departmentIds:[Int] = []

    // @Ignore()
    public var mainAssigneeIds:[Int] = []

    // @Ignore()
    public var coDepartmentIds:[Int] = []

    // @Ignore()
    public var supportingAssigneeIds:[Int] = []

    // @Ignore()
    public var stepBasisDocumentIds:[Int] = []

    // @Ignore()
    public var attachedDocuments:[StepAttached] = []

    required public init(){}
}

public class StepAttached : Codable
{
    public var id:Int
    public var documentCode:String
    public var title:String
    public var isSequentialSigning:Bool?
    public var pendingSignFile:UploadedFiles
    public var originalFile:UploadedFiles
    public var signerConfigs:[SignerConfigDetail] = []

    required public init(){}
}

public class UploadedFiles : BasicUploadedFile
{
    public var id:Int?
    public var uploadedFile:String
    public var subDocumentId:Int?
    public var stepId:Int?
    public var code:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case uploadedFile
        case subDocumentId
        case stepId
        case code
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        uploadedFile = try container.decodeIfPresent(String.self, forKey: .uploadedFile)
        subDocumentId = try container.decodeIfPresent(Int.self, forKey: .subDocumentId)
        stepId = try container.decodeIfPresent(Int.self, forKey: .stepId)
        code = try container.decodeIfPresent(Int.self, forKey: .code)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if uploadedFile != nil { try container.encode(uploadedFile, forKey: .uploadedFile) }
        if subDocumentId != nil { try container.encode(subDocumentId, forKey: .subDocumentId) }
        if stepId != nil { try container.encode(stepId, forKey: .stepId) }
        if code != nil { try container.encode(code, forKey: .code) }
    }
}

public class BasicUploadedFile : Codable
{
    public var fileName:String
    public var filekey:String
    public var fileUrl:String
    public var checksum:String
    public var eTag:String
    public var fileSize:Int

    required public init(){}
}

public class SignerConfigDetail : SignerConfig
{
    public var profile:WorkFlowProfile
    public var role:Roles

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case profile
        case role
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        profile = try container.decodeIfPresent(WorkFlowProfile.self, forKey: .profile)
        role = try container.decodeIfPresent(Roles.self, forKey: .role)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if profile != nil { try container.encode(profile, forKey: .profile) }
        if role != nil { try container.encode(role, forKey: .role) }
    }
}

public class SignerConfig : BasicSignerConfig
{
    public var id:Int
    public var documentId:Int
    public var stepId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case documentId
        case stepId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        documentId = try container.decodeIfPresent(Int.self, forKey: .documentId)
        stepId = try container.decodeIfPresent(Int.self, forKey: .stepId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if documentId != nil { try container.encode(documentId, forKey: .documentId) }
        if stepId != nil { try container.encode(stepId, forKey: .stepId) }
    }
}

public class BasicSignerConfig : Codable
{
    public var subDocumentId:Int?
    public var departmentId:Int?
    public var signerType:UInt8
    public var signerRefId:Int
    // @Ignore()
    public var signerRefText:String

    public var actionType:UInt8
    public var orderIndex:Int

    required public init(){}
}

public class WorkFlowProfile : Codable
{
    public var id:Int
    public var name:String
    public var fullName:String
    public var email:String
    public var departmentId:Int?
    public var avatar:String
    public var telephone:String
    public var birthday:Date?
    public var confirmStatus:Int?
    public var confirmStatusText:String
    public var signAt:Date?
    public var signedFileId:Int?
    public var originalFileId:Int?
    public var signedFileName:String
    public var isSigned:Bool
    public var signStatusText:String

    required public init(){}
}

public class Roles : Codable
{
    public var id:Int
    // @StringLength(50)
    public var name:String

    public var createdAt:Date?
    public var deletedAt:Date?
    public var updatedAt:Date?
    public var updatedBy:Int?
    public var deletedBy:Int?
    public var createdBy:Int?
    // @Ignore()
    public var permission:[String] = []

    required public init(){}
}

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

    required public init(){}
}

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