tvpl.api

<back to all web services

GetDocumentNumberFormatRequest

Requires Authentication
The following routes are available for this service:
GET/document-number-format/{Id}
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 GetDocumentNumberFormatRequest
    {
        public virtual int Id { 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# GetDocumentNumberFormatRequest 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.

GET /document-number-format/{Id} HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentNumberFormat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
  <CreatedAt>0001-01-01T00:00:00</CreatedAt>
  <CreatedBy>0</CreatedBy>
  <DeletedAt>0001-01-01T00:00:00</DeletedAt>
  <DeletedBy>0</DeletedBy>
  <FormatTemplate>String</FormatTemplate>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <IsDeleted>false</IsDeleted>
  <LabelKeys>String</LabelKeys>
  <Name>String</Name>
  <Padding>0</Padding>
  <ResetPeriod>0</ResetPeriod>
  <TypeKey>String</TypeKey>
  <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy>0</UpdatedBy>
</DocumentNumberFormat>