tvpl.api

<back to all web services

GetWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/by-workflow
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using tvpl.api.ServiceModel;
using tvpl.data.Models;
using tvpl.data.Constant;

namespace tvpl.api.ServiceModel
{
    public partial class GetWorkflowStepRequest
    {
        public virtual int WorkflowId { get; set; }
    }

    public partial class GetWorkflowStepResponse
        : IResponseRequest
    {
        public GetWorkflowStepResponse()
        {
            Data = new List<WorkflowStepDetail>{};
        }

        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
        public virtual List<WorkflowStepDetail> Data { get; set; }
    }

}

namespace tvpl.data.Constant
{
    public enum AccessType
    {
        Public,
        Restricted,
    }

    public enum CategoryTypes
    {
        Department,
        PartyGroup,
        DocGroup,
        DocType,
        IssuingAgency,
        Status,
        Subjects,
        Workflow,
    }

}

namespace tvpl.data.Models
{
    public partial class BasicUploadedFile
    {
        public virtual string FileName { get; set; }
        public virtual string Filekey { get; set; }
        public virtual string FileUrl { get; set; }
        public virtual string Checksum { get; set; }
        public virtual string ETag { get; set; }
        public virtual long FileSize { get; set; }
    }

    public partial class Category
        : CreateCategoryModel
    {
        public Category()
        {
            Children = new List<Category>{};
        }

        public virtual int Id { get; set; }
        public virtual int Level { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual DateTime? LastUpdate { get; set; }
        [Ignore]
        public virtual List<Category> Children { get; set; }
    }

    public partial class CreateCategoryModel
    {
        public CreateCategoryModel()
        {
            ChildList = new List<int>{};
        }

        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual CategoryTypes Type { get; set; }
        public virtual bool IsParty { get; set; }
        [Ignore]
        public virtual List<int> ChildList { get; set; }
    }

    public partial class SimpleDocumentRelation
    {
        public virtual int Id { get; set; }
        public virtual string Title { get; set; }
        public virtual string DocumentCode { get; set; }
        public virtual DateTime? PublicationDate { get; set; }
    }

    public partial class UploadedFileAttach
        : UploadedFileModel
    {
        public virtual string FileType { get; set; }
        public virtual int? SubDocumentId { get; set; }
        public virtual int? StepId { get; set; }
    }

    public partial class UploadedFileModel
        : BasicUploadedFile
    {
        public virtual long Id { get; set; }
        public virtual AccessType AccessType { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual DateTime CreatedDate { get; set; }
    }

    public partial class WorkFlowProfile
    {
        public virtual int Id { get; set; }
        public virtual string FullName { get; set; }
        public virtual string Email { get; set; }
        public virtual int? DepartmentId { get; set; }
        public virtual string Avatar { get; set; }
        public virtual string Telephone { get; set; }
        public virtual DateTime? Birthday { get; set; }
        public virtual int? ConfirmStatus { get; set; }
    }

    public partial class WorkflowStep
    {
        public WorkflowStep()
        {
            DepartmentIds = new List<int>{};
            StepBasisDocumentIds = new List<int>{};
            StepAttachedIds = new List<int>{};
            MainAssigneeIds = new List<int>{};
        }

        public virtual int Id { get; set; }
        [References(typeof(tvpl.data.Models.Document))]
        public virtual int WorkflowId { get; set; }

        public virtual int? StepOrder { get; set; }
        [Required]
        [StringLength(255)]
        public virtual string StepName { get; set; }

        [Required]
        public virtual bool IsRequired { get; set; }

        public virtual int? SLALegalValue { get; set; }
        public virtual bool? SLALegalIsByDay { get; set; }
        public virtual int? SLAInternalValue { get; set; }
        public virtual bool? SLAInternalIsByDay { get; set; }
        public virtual bool RequireAttachment { get; set; }
        [Required]
        public virtual string Description { get; set; }

        public virtual int CreatedBy { get; set; }
        [Ignore]
        public virtual List<int> DepartmentIds { get; set; }

        [Ignore]
        public virtual List<int> StepBasisDocumentIds { get; set; }

        [Ignore]
        public virtual List<int> StepAttachedIds { get; set; }

        [Ignore]
        public virtual List<int> MainAssigneeIds { get; set; }
    }

    public partial class WorkflowStepDetail
        : WorkflowStep
    {
        public WorkflowStepDetail()
        {
            Departments = new List<Category>{};
            BasisDocuments = new List<SimpleDocumentRelation>{};
            AttachedDocuments = new List<SimpleDocumentRelation>{};
            ReferenceDocuments = new List<SimpleDocumentRelation>{};
            MainAssignees = new List<WorkFlowProfile>{};
            AttachFiles = new List<UploadedFileAttach>{};
        }

        public virtual List<Category> Departments { get; set; }
        public virtual List<SimpleDocumentRelation> BasisDocuments { get; set; }
        public virtual List<SimpleDocumentRelation> AttachedDocuments { get; set; }
        public virtual List<SimpleDocumentRelation> ReferenceDocuments { get; set; }
        public virtual List<WorkFlowProfile> MainAssignees { get; set; }
        public virtual List<UploadedFileAttach> AttachFiles { get; set; }
    }

}

C# 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
			]
		}
	]
}