tvpl.api

<back to all web services

GetWorkflowStepRequest

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

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class GetWorkflowStepRequest
            Public Overridable Property WorkflowId As Integer
        End Class

        Public Partial Class GetWorkflowStepResponse
            Implements IResponseRequest
            Public Sub New()
                Data = New List(Of WorkflowStepDetail)
            End Sub

            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
            Public Overridable Property Data As List(Of WorkflowStepDetail)
        End Class
    End Namespace

    Namespace tvpl.data.Constant

        Public Enum CategoryTypes
            Department
            PartyGroup
            DocGroup
            DocType
            IssuingAgency
            Status
            Subjects
            Workflow
            WorkStatus
            StepStatus
            SignStatus
        End Enum
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class BasicSignerConfig
            Public Overridable Property SubDocumentId As Nullable(Of Integer)
            Public Overridable Property DepartmentId As Nullable(Of Integer)
            Public Overridable Property SignerType As Byte
            Public Overridable Property SignerRefId As Integer
            <Ignore>
            Public Overridable Property SignerRefText As String

            Public Overridable Property ActionType As Byte
            Public Overridable Property OrderIndex As Integer
        End Class

        Public Partial Class BasicUploadedFile
            Public Overridable Property FileName As String
            Public Overridable Property Filekey As String
            Public Overridable Property FileUrl As String
            Public Overridable Property Checksum As String
            Public Overridable Property ETag As String
            Public Overridable Property FileSize As Long
        End Class

        Public Partial Class Category
            Inherits CreateCategoryModel
            Public Sub New()
                Children = New List(Of Category)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property Level As Integer
            Public Overridable Property Key As String
            Public Overridable Property SortOrder As Integer
            Public Overridable Property LastUpdate As Nullable(Of Date)
            <Ignore>
            Public Overridable Property Children As List(Of Category)
        End Class

        Public Partial Class CreateCategoryModel
            Public Sub New()
                ChildList = New List(Of Integer)
            End Sub

            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Type As CategoryTypes
            Public Overridable Property IsParty As Boolean
            <Ignore>
            Public Overridable Property ChildList As List(Of Integer)
        End Class

        Public Partial Class Roles
            Public Sub New()
                Permission = New List(Of String)
            End Sub

            Public Overridable Property Id As Integer
            <StringLength(50)>
            Public Overridable Property Name As String

            Public Overridable Property CreatedAt As Nullable(Of Date)
            Public Overridable Property DeletedAt As Nullable(Of Date)
            Public Overridable Property UpdatedAt As Nullable(Of Date)
            Public Overridable Property UpdatedBy As Nullable(Of Integer)
            Public Overridable Property DeletedBy As Nullable(Of Integer)
            Public Overridable Property CreatedBy As Nullable(Of Integer)
            <Ignore>
            Public Overridable Property Permission As List(Of String)
        End Class

        Public Partial Class SignerConfig
            Inherits BasicSignerConfig
            Public Overridable Property Id As Integer
            Public Overridable Property DocumentId As Integer
            Public Overridable Property StepId As Nullable(Of Integer)
        End Class

        Public Partial Class SignerConfigDetail
            Inherits SignerConfig
            Public Overridable Property Profile As WorkFlowProfile
            Public Overridable Property Role As Roles
        End Class

        Public Partial Class SimpleDocumentRelation
            Public Overridable Property Id As Integer
            Public Overridable Property Title As String
            Public Overridable Property DocumentCode As String
            Public Overridable Property PublicationDate As Nullable(Of Date)
            Public Overridable Property IsSequentialSigning As Nullable(Of Boolean)
            Public Overridable Property StatusText As String
            Public Overridable Property DocumentTypeId As Nullable(Of Integer)
        End Class

        Public Partial Class StepAttached
            Public Sub New()
                SignerConfigs = New List(Of SignerConfigDetail)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property DocumentCode As String
            Public Overridable Property Title As String
            Public Overridable Property IsSequentialSigning As Nullable(Of Boolean)
            Public Overridable Property PendingSignFile As UploadedFiles
            Public Overridable Property OriginalFile As UploadedFiles
            Public Overridable Property SignerConfigs As List(Of SignerConfigDetail)
        End Class

        Public Partial Class UploadedFiles
            Inherits BasicUploadedFile
            Public Overridable Property Id As Nullable(Of Long)
            Public Overridable Property UploadedFile As String
            Public Overridable Property SubDocumentId As Nullable(Of Integer)
            Public Overridable Property StepId As Nullable(Of Integer)
            Public Overridable Property Code As Integer
        End Class

        Public Partial Class WorkFlowProfile
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property FullName As String
            Public Overridable Property Email As String
            Public Overridable Property DepartmentId As Nullable(Of Integer)
            Public Overridable Property Avatar As String
            Public Overridable Property Telephone As String
            Public Overridable Property Birthday As Nullable(Of Date)
            Public Overridable Property ConfirmStatus As Nullable(Of Integer)
            Public Overridable Property ConfirmStatusText As String
            Public Overridable Property SignAt As Nullable(Of Date)
            Public Overridable Property SignedFileId As Nullable(Of Long)
            Public Overridable Property OriginalFileId As Nullable(Of Integer)
            Public Overridable Property SignedFileName As String
            Public Overridable Property IsSigned As Boolean
            Public Overridable Property SignStatusText As String
        End Class

        Public Partial Class WorkflowStep
            Public Sub New()
                DepartmentIds = New List(Of Integer)
                MainAssigneeIds = New List(Of Integer)
                CoDepartmentIds = New List(Of Integer)
                SupportingAssigneeIds = New List(Of Integer)
                StepBasisDocumentIds = New List(Of Integer)
                AttachedDocuments = New List(Of StepAttached)
            End Sub

            Public Overridable Property Id As Integer
            <References(GetType(Document))>
            Public Overridable Property WorkflowId As Integer

            Public Overridable Property StepOrder As Nullable(Of Integer)
            Public Overridable Property StatusId As Nullable(Of Integer)
            <Required>
            <StringLength(255)>
            Public Overridable Property StepName As String

            <Required>
            Public Overridable Property IsRequired As Boolean

            Public Overridable Property SLALegalValue As Nullable(Of Integer)
            Public Overridable Property SLALegalIsByDay As Nullable(Of Boolean)
            Public Overridable Property SLAInternalValue As Nullable(Of Integer)
            Public Overridable Property SLAInternalIsByDay As Nullable(Of Boolean)
            Public Overridable Property RequireAttachment As Boolean
            Public Overridable Property IsUsingForm As Nullable(Of Boolean)
            <Required>
            Public Overridable Property Description As String

            Public Overridable Property CreatedBy As Integer
            <Ignore>
            Public Overridable Property DepartmentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property MainAssigneeIds As List(Of Integer)

            <Ignore>
            Public Overridable Property CoDepartmentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property SupportingAssigneeIds As List(Of Integer)

            <Ignore>
            Public Overridable Property StepBasisDocumentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property AttachedDocuments As List(Of StepAttached)
        End Class

        Public Partial Class WorkflowStepDetail
            Inherits WorkflowStep
            Public Sub New()
                Departments = New List(Of Category)
                CoDepartments = New List(Of Category)
                BasisDocuments = New List(Of SimpleDocumentRelation)
                ReferenceDocuments = New List(Of SimpleDocumentRelation)
                MainAssignees = New List(Of WorkFlowProfile)
                SupportingAssignees = New List(Of WorkFlowProfile)
            End Sub

            Public Overridable Property Departments As List(Of Category)
            Public Overridable Property CoDepartments As List(Of Category)
            Public Overridable Property BasisDocuments As List(Of SimpleDocumentRelation)
            Public Overridable Property ReferenceDocuments As List(Of SimpleDocumentRelation)
            Public Overridable Property MainAssignees As List(Of WorkFlowProfile)
            Public Overridable Property SupportingAssignees As List(Of WorkFlowProfile)
            Public Overridable Property StatusKey As String
            Public Overridable Property StatusText As String
            <Ignore>
            Public Overridable Property CanRead As Nullable(Of Boolean)

            <Ignore>
            Public Overridable Property CanWrite As Nullable(Of Boolean)

            <Ignore>
            Public Overridable Property CanUpload As Nullable(Of Boolean)

            Public Overridable Property ReasonReturn As String
            Public Overridable Property ReturnDate As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET GetWorkflowStepRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"code":0,"message":"String","data":[{"departments":[{"id":0,"level":0,"key":"String","sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"key":"String","sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"key":"String","sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":null,"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]}],"coDepartments":[{"id":0,"level":0,"key":"String","sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"key":"String","sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"key":"String","sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":null,"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","isSequentialSigning":false,"statusText":"String","documentTypeId":0}],"referenceDocuments":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06","isSequentialSigning":false,"statusText":"String","documentTypeId":0}],"mainAssignees":[{"id":0,"name":"String","fullName":"String","email":"String","departmentId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","confirmStatus":0,"confirmStatusText":"String","signAt":"0001-01-01T00:00:00.0000000+07:06","signedFileId":0,"originalFileId":0,"signedFileName":"String","isSigned":false,"signStatusText":"String"}],"supportingAssignees":[{"id":0,"name":"String","fullName":"String","email":"String","departmentId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","confirmStatus":0,"confirmStatusText":"String","signAt":"0001-01-01T00:00:00.0000000+07:06","signedFileId":0,"originalFileId":0,"signedFileName":"String","isSigned":false,"signStatusText":"String"}],"statusKey":"String","statusText":"String","canRead":false,"canWrite":false,"canUpload":false,"reasonReturn":"String","returnDate":"0001-01-01T00:00:00.0000000+07:06","id":0,"workflowId":0,"stepOrder":0,"statusId":0,"stepName":"String","isRequired":false,"slaLegalValue":0,"slaLegalIsByDay":false,"slaInternalValue":0,"slaInternalIsByDay":false,"requireAttachment":false,"isUsingForm":false,"description":"String","createdBy":0,"departmentIds":[0],"mainAssigneeIds":[0],"coDepartmentIds":[0],"supportingAssigneeIds":[0],"stepBasisDocumentIds":[0],"attachedDocuments":[{"id":0,"documentCode":"String","title":"String","isSequentialSigning":false,"pendingSignFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"originalFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"signerConfigs":[{"profile":{"id":0,"name":"String","fullName":"String","email":"String","departmentId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","confirmStatus":0,"confirmStatusText":"String","signAt":"0001-01-01T00:00:00.0000000+07:06","signedFileId":0,"originalFileId":0,"signedFileName":"String","isSigned":false,"signStatusText":"String"},"role":{"id":0,"name":"String","createdAt":"0001-01-01T00:00:00.0000000+07:06","deletedAt":"0001-01-01T00:00:00.0000000+07:06","updatedAt":"0001-01-01T00:00:00.0000000+07:06","updatedBy":0,"deletedBy":0,"createdBy":0,"permission":["String"]},"id":0,"documentId":0,"stepId":0,"subDocumentId":0,"departmentId":0,"signerType":0,"signerRefId":0,"signerRefText":"String","actionType":0,"orderIndex":0}]}]}]}