tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
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;

namespace tvpl.api.ServiceModel
{
    public partial class CreateWorkflowStepRequest
        : WorkflowStep
    {
    }

    public partial class WorkflowStepResponse
        : IResponseRequest
    {
        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
        public virtual int InsertedId { get; set; }
    }

}

namespace tvpl.data.Models
{
    public partial class BasicSignerConfig
    {
        public virtual int? SubDocumentId { get; set; }
        public virtual int? DepartmentId { get; set; }
        public virtual byte SignerType { get; set; }
        public virtual int SignerRefId { get; set; }
        [Ignore]
        public virtual string SignerRefText { get; set; }

        public virtual byte ActionType { get; set; }
        public virtual int OrderIndex { get; set; }
    }

    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 Roles
    {
        public Roles()
        {
            Permission = new List<string>{};
        }

        public virtual int Id { get; set; }
        [StringLength(50)]
        public virtual string Name { get; set; }

        public virtual DateTime? CreatedAt { get; set; }
        public virtual DateTime? DeletedAt { get; set; }
        public virtual DateTime? UpdatedAt { get; set; }
        public virtual int? UpdatedBy { get; set; }
        public virtual int? DeletedBy { get; set; }
        public virtual int? CreatedBy { get; set; }
        [Ignore]
        public virtual List<string> Permission { get; set; }
    }

    public partial class SignerConfig
        : BasicSignerConfig
    {
        public virtual int Id { get; set; }
        public virtual int DocumentId { get; set; }
        public virtual int? StepId { get; set; }
    }

    public partial class SignerConfigDetail
        : SignerConfig
    {
        public virtual WorkFlowProfile Profile { get; set; }
        public virtual Roles Role { get; set; }
    }

    public partial class StepAttached
    {
        public StepAttached()
        {
            SignerConfigs = new List<SignerConfigDetail>{};
        }

        public virtual int Id { get; set; }
        public virtual string DocumentCode { get; set; }
        public virtual string Title { get; set; }
        public virtual bool? IsSequentialSigning { get; set; }
        public virtual UploadedFiles PendingSignFile { get; set; }
        public virtual UploadedFiles OriginalFile { get; set; }
        public virtual List<SignerConfigDetail> SignerConfigs { get; set; }
    }

    public partial class UploadedFiles
        : BasicUploadedFile
    {
        public virtual long? Id { get; set; }
        public virtual string UploadedFile { get; set; }
        public virtual int? SubDocumentId { get; set; }
        public virtual int? StepId { get; set; }
        public virtual int Code { get; set; }
    }

    public partial class WorkFlowProfile
    {
        public virtual int Id { get; set; }
        public virtual string Name { 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 virtual string ConfirmStatusText { get; set; }
        public virtual DateTime? SignAt { get; set; }
        public virtual long? SignedFileId { get; set; }
        public virtual int? OriginalFileId { get; set; }
        public virtual string SignedFileName { get; set; }
        public virtual bool IsSigned { get; set; }
        public virtual string SignStatusText { get; set; }
    }

    public partial class WorkflowStep
    {
        public WorkflowStep()
        {
            DepartmentIds = new List<int>{};
            MainAssigneeIds = new List<int>{};
            CoDepartmentIds = new List<int>{};
            SupportingAssigneeIds = new List<int>{};
            StepBasisDocumentIds = new List<int>{};
            AttachedDocuments = new List<StepAttached>{};
        }

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

        public virtual int? StepOrder { get; set; }
        public virtual int? StatusId { 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; }
        public virtual bool? IsUsingForm { 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> MainAssigneeIds { get; set; }

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

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

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

        [Ignore]
        public virtual List<StepAttached> AttachedDocuments { get; set; }
    }

}

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