tvpl.api

<back to all web services

GetWorkflowStepRequest

Requires Authentication
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			departments: 
			[
				{
					id: 0,
					level: 0,
					sortOrder: 0,
					lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
					children: 
					[
						{
							id: 0,
							level: 0,
							sortOrder: 0,
							lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
							children: 
							[
								{
									id: 0,
									level: 0,
									sortOrder: 0,
									lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
									name: String,
									description: String,
									type: Department,
									isParty: False,
									childList: 
									[
										0
									]
								}
							],
							name: String,
							description: String,
							type: Department,
							isParty: False,
							childList: 
							[
								0
							]
						}
					],
					name: String,
					description: String,
					type: Department,
					isParty: False,
					childList: 
					[
						0
					]
				}
			],
			basisDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			attachedDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			referenceDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			mainAssignees: 
			[
				{
					id: 0,
					fullName: String,
					email: String,
					departmentId: 0,
					avatar: String,
					telephone: String,
					birthday: "0001-01-01T00:00:00.0000000+07:06",
					confirmStatus: 0
				}
			],
			attachFiles: 
			[
				{
					fileType: String,
					subDocumentId: 0,
					stepId: 0,
					id: 0,
					accessType: Public,
					createdBy: 0,
					fileName: String,
					filekey: String,
					fileUrl: String,
					checksum: String,
					eTag: String,
					fileSize: 0
				}
			],
			id: 0,
			workflowId: 0,
			stepOrder: 0,
			stepName: String,
			isRequired: False,
			slaLegalValue: 0,
			slaLegalIsByDay: False,
			slaInternalValue: 0,
			slaInternalIsByDay: False,
			requireAttachment: False,
			description: String,
			createdBy: 0,
			departmentIds: 
			[
				0
			],
			stepBasisDocumentIds: 
			[
				0
			],
			stepAttachedIds: 
			[
				0
			],
			mainAssigneeIds: 
			[
				0
			]
		}
	]
}