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
namespace tvpl.api.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentNumberFormat() = 
        member val Id:Int32 = new Int32() with get,set
        [<Required>]
        [<StringLength(50)>]
        member val TypeKey:String = null with get,set

        [<Required>]
        [<StringLength(255)>]
        member val Name:String = null with get,set

        [<Required>]
        [<StringLength(255)>]
        member val FormatTemplate:String = null with get,set

        member val Padding:Int32 = new Int32() with get,set
        member val ResetPeriod:Int32 = new Int32() with get,set
        [<StringLength(500)>]
        member val LabelKeys:String = null with get,set

        member val IsActive:Boolean = new Boolean() with get,set
        member val IsDeleted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DeletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeletedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CreateDocumentNumberFormatRequest() = 
        member val TypeKey:String = null with get,set
        member val Name:String = null with get,set
        member val FormatTemplate:String = null with get,set
        member val Padding:Int32 = new Int32() with get,set
        member val ResetPeriod:Int32 = new Int32() with get,set
        member val LabelKeys:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set

F# CreateDocumentNumberFormatRequest 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 /document-number-format HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateDocumentNumberFormatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <FormatTemplate>String</FormatTemplate>
  <IsActive>false</IsActive>
  <LabelKeys>String</LabelKeys>
  <Name>String</Name>
  <Padding>0</Padding>
  <ResetPeriod>0</ResetPeriod>
  <TypeKey>String</TypeKey>
</CreateDocumentNumberFormatRequest>
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>