tvpl.api

<back to all web services

CreateDocumentNumberFormatRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/document-number-format
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 CreateDocumentNumberFormatRequest
    {
        public virtual string TypeKey { get; set; }
        public virtual string Name { get; set; }
        public virtual string FormatTemplate { get; set; }
        public virtual int Padding { get; set; }
        public virtual int ResetPeriod { get; set; }
        public virtual string LabelKeys { get; set; }
        public virtual bool IsActive { get; set; }
    }

}

namespace tvpl.data.Models
{
    public partial class DocumentNumberFormat
    {
        public virtual int Id { get; set; }
        [Required]
        [StringLength(50)]
        public virtual string TypeKey { get; set; }

        [Required]
        [StringLength(255)]
        public virtual string Name { get; set; }

        [Required]
        [StringLength(255)]
        public virtual string FormatTemplate { get; set; }

        public virtual int Padding { get; set; }
        public virtual int ResetPeriod { get; set; }
        [StringLength(500)]
        public virtual string LabelKeys { get; set; }

        public virtual bool IsActive { get; set; }
        public virtual bool? IsDeleted { get; set; }
        public virtual DateTime? DeletedAt { get; set; }
        public virtual int? DeletedBy { get; set; }
        public virtual DateTime? CreatedAt { get; set; }
        public virtual int? CreatedBy { get; set; }
        public virtual DateTime? UpdatedAt { get; set; }
        public virtual int? UpdatedBy { get; set; }
    }

}

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

POST /document-number-format HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"typeKey":"String","name":"String","formatTemplate":"String","padding":0,"resetPeriod":0,"labelKeys":"String","isActive":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"typeKey":"String","name":"String","formatTemplate":"String","padding":0,"resetPeriod":0,"labelKeys":"String","isActive":false,"isDeleted":false,"deletedAt":"0001-01-01T00:00:00.0000000+07:06","deletedBy":0,"createdAt":"0001-01-01T00:00:00.0000000+07:06","createdBy":0,"updatedAt":"0001-01-01T00:00:00.0000000+07:06","updatedBy":0}