tvpl.api

GetWorkflowStepRequest

The following routes are available for this service:
GET	/WorkflowStep/by-workflow

import Foundation
import ServiceStack

public class GetWorkflowStepRequest : Codable
{
    public var workflowId:Int

    required public init(){}
}

public class GetWorkflowStepResponse : IResponseRequest, Codable
{
    public var code:Int
    public var message:String
    public var data:[WorkflowStepDetail] = []

    required public init(){}
}

public class WorkflowStepDetail : WorkflowStep
{
    public var departments:[Category] = []
    public var basisDocuments:[SimpleDocumentRelation] = []
    public var attachedDocuments:[SimpleDocumentRelation] = []
    public var referenceDocuments:[SimpleDocumentRelation] = []
    public var mainAssignees:[WorkFlowProfile] = []
    public var attachFiles:[UploadedFileAttach] = []

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

    private enum CodingKeys : String, CodingKey {
        case departments
        case basisDocuments
        case attachedDocuments
        case referenceDocuments
        case mainAssignees
        case attachFiles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        departments = try container.decodeIfPresent([Category].self, forKey: .departments) ?? []
        basisDocuments = try container.decodeIfPresent([SimpleDocumentRelation].self, forKey: .basisDocuments) ?? []
        attachedDocuments = try container.decodeIfPresent([SimpleDocumentRelation].self, forKey: .attachedDocuments) ?? []
        referenceDocuments = try container.decodeIfPresent([SimpleDocumentRelation].self, forKey: .referenceDocuments) ?? []
        mainAssignees = try container.decodeIfPresent([WorkFlowProfile].self, forKey: .mainAssignees) ?? []
        attachFiles = try container.decodeIfPresent([UploadedFileAttach].self, forKey: .attachFiles) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if departments.count > 0 { try container.encode(departments, forKey: .departments) }
        if basisDocuments.count > 0 { try container.encode(basisDocuments, forKey: .basisDocuments) }
        if attachedDocuments.count > 0 { try container.encode(attachedDocuments, forKey: .attachedDocuments) }
        if referenceDocuments.count > 0 { try container.encode(referenceDocuments, forKey: .referenceDocuments) }
        if mainAssignees.count > 0 { try container.encode(mainAssignees, forKey: .mainAssignees) }
        if attachFiles.count > 0 { try container.encode(attachFiles, forKey: .attachFiles) }
    }
}

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

    public var stepOrder: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
    // @Required()
    public var Description:String?

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

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

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

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

    required public init(){}
}

public class Category : CreateCategoryModel
{
    public var id:Int
    public var level:Int
    public var sortOrder:Int
    public var lastUpdate:Date?
    // @Ignore()
    public var children:[Category] = []

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

    private enum CodingKeys : String, CodingKey {
        case id
        case level
        case sortOrder
        case lastUpdate
        case children
    }

    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)
        level = try container.decodeIfPresent(Int.self, forKey: .level)
        sortOrder = try container.decodeIfPresent(Int.self, forKey: .sortOrder)
        lastUpdate = try container.decodeIfPresent(Date.self, forKey: .lastUpdate)
        children = try container.decodeIfPresent([Category].self, forKey: .children) ?? []
    }

    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 level != nil { try container.encode(level, forKey: .level) }
        if sortOrder != nil { try container.encode(sortOrder, forKey: .sortOrder) }
        if lastUpdate != nil { try container.encode(lastUpdate, forKey: .lastUpdate) }
        if children.count > 0 { try container.encode(children, forKey: .children) }
    }
}

public class CreateCategoryModel : Codable
{
    public var name:String
    public var Description:String
    public var type:CategoryTypes
    public var isParty:Bool
    // @Ignore()
    public var childList:[Int] = []

    required public init(){}
}

public enum CategoryTypes : String, Codable
{
    case Department
    case PartyGroup
    case DocGroup
    case DocType
    case IssuingAgency
    case Status
    case Subjects
    case Workflow
}

public class SimpleDocumentRelation : Codable
{
    public var id:Int
    public var title:String
    public var documentCode:String
    public var publicationDate:Date?

    required public init(){}
}

public class WorkFlowProfile : Codable
{
    public var id:Int
    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?

    required public init(){}
}

public class UploadedFileAttach : UploadedFileModel
{
    public var fileType:String
    public var subDocumentId:Int?
    public var stepId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case fileType
        case subDocumentId
        case stepId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        fileType = try container.decodeIfPresent(String.self, forKey: .fileType)
        subDocumentId = try container.decodeIfPresent(Int.self, forKey: .subDocumentId)
        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 fileType != nil { try container.encode(fileType, forKey: .fileType) }
        if subDocumentId != nil { try container.encode(subDocumentId, forKey: .subDocumentId) }
        if stepId != nil { try container.encode(stepId, forKey: .stepId) }
    }
}

public class UploadedFileModel : BasicUploadedFile
{
    public var id:Int
    public var accessType:AccessType
    public var createdBy:Int
    public var createdDate:Date

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

    private enum CodingKeys : String, CodingKey {
        case id
        case accessType
        case createdBy
        case createdDate
    }

    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)
        accessType = try container.decodeIfPresent(AccessType.self, forKey: .accessType)
        createdBy = try container.decodeIfPresent(Int.self, forKey: .createdBy)
        createdDate = try container.decodeIfPresent(Date.self, forKey: .createdDate)
    }

    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 accessType != nil { try container.encode(accessType, forKey: .accessType) }
        if createdBy != nil { try container.encode(createdBy, forKey: .createdBy) }
        if createdDate != nil { try container.encode(createdDate, forKey: .createdDate) }
    }
}

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 enum AccessType : String, Codable
{
    case Public
    case Restricted
}

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

GET /WorkflowStep/by-workflow HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

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

<GetWorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:WorkflowStepDetail>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:DepartmentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:DepartmentIds>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsRequired>false</d2p1:IsRequired>
      <d2p1:MainAssigneeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:MainAssigneeIds>
      <d2p1:RequireAttachment>false</d2p1:RequireAttachment>
      <d2p1:SLAInternalIsByDay>false</d2p1:SLAInternalIsByDay>
      <d2p1:SLAInternalValue>0</d2p1:SLAInternalValue>
      <d2p1:SLALegalIsByDay>false</d2p1:SLALegalIsByDay>
      <d2p1:SLALegalValue>0</d2p1:SLALegalValue>
      <d2p1:SLAWarningSentAt>0001-01-01T00:00:00</d2p1:SLAWarningSentAt>
      <d2p1:SLAWarningSentCount>0</d2p1:SLAWarningSentCount>
      <d2p1:StepAttachedIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:StepAttachedIds>
      <d2p1:StepBasisDocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:StepBasisDocumentIds>
      <d2p1:StepName>String</d2p1:StepName>
      <d2p1:StepOrder>0</d2p1:StepOrder>
      <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
      <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
      <d2p1:WorkflowId>0</d2p1:WorkflowId>
      <d2p1:AttachFiles>
        <d2p1:UploadedFileAttach>
          <d2p1:Checksum>String</d2p1:Checksum>
          <d2p1:ETag>String</d2p1:ETag>
          <d2p1:FileName>String</d2p1:FileName>
          <d2p1:FileSize>0</d2p1:FileSize>
          <d2p1:FileUrl>String</d2p1:FileUrl>
          <d2p1:Filekey>String</d2p1:Filekey>
          <d2p1:AccessType>Public</d2p1:AccessType>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:FileType>String</d2p1:FileType>
          <d2p1:StepId>0</d2p1:StepId>
          <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
        </d2p1:UploadedFileAttach>
      </d2p1:AttachFiles>
      <d2p1:AttachedDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:AttachedDocuments>
      <d2p1:BasisDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:BasisDocuments>
      <d2p1:Departments>
        <d2p1:Category>
          <d2p1:ChildList xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:ChildList>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:IsParty>false</d2p1:IsParty>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Type>Department</d2p1:Type>
          <d2p1:Children>
            <d2p1:Category>
              <d2p1:ChildList xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </d2p1:ChildList>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:IsParty>false</d2p1:IsParty>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Type>Department</d2p1:Type>
              <d2p1:Children>
                <d2p1:Category>
                  <d2p1:ChildList xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:int>0</d10p1:int>
                  </d2p1:ChildList>
                  <d2p1:Description>String</d2p1:Description>
                  <d2p1:IsParty>false</d2p1:IsParty>
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:Type>Department</d2p1:Type>
                  <d2p1:Children i:nil="true" />
                  <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
                  <d2p1:CreatedBy>0</d2p1:CreatedBy>
                  <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
                  <d2p1:DeletedBy>0</d2p1:DeletedBy>
                  <d2p1:Id>0</d2p1:Id>
                  <d2p1:IsDeleted>false</d2p1:IsDeleted>
                  <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
                  <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
                  <d2p1:Level>0</d2p1:Level>
                  <d2p1:SortOrder>0</d2p1:SortOrder>
                </d2p1:Category>
              </d2p1:Children>
              <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
              <d2p1:CreatedBy>0</d2p1:CreatedBy>
              <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
              <d2p1:DeletedBy>0</d2p1:DeletedBy>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:IsDeleted>false</d2p1:IsDeleted>
              <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
              <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
              <d2p1:Level>0</d2p1:Level>
              <d2p1:SortOrder>0</d2p1:SortOrder>
            </d2p1:Category>
          </d2p1:Children>
          <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
          <d2p1:DeletedBy>0</d2p1:DeletedBy>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsDeleted>false</d2p1:IsDeleted>
          <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
          <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
          <d2p1:Level>0</d2p1:Level>
          <d2p1:SortOrder>0</d2p1:SortOrder>
        </d2p1:Category>
      </d2p1:Departments>
      <d2p1:MainAssignees>
        <d2p1:WorkFlowProfile>
          <d2p1:Avatar>String</d2p1:Avatar>
          <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
          <d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
          <d2p1:DepartmentId>0</d2p1:DepartmentId>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:FullName>String</d2p1:FullName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Telephone>String</d2p1:Telephone>
        </d2p1:WorkFlowProfile>
      </d2p1:MainAssignees>
      <d2p1:ReferenceDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:ReferenceDocuments>
    </d2p1:WorkflowStepDetail>
  </Data>
  <Message>String</Message>
</GetWorkflowStepResponse>