tvpl.api

<back to all web services

CreateOrUpdateTemplateRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/document-template
namespace tvpl.api.ServiceModel

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

    [<AllowNullLiteral>]
    type CreateDocumentTemplateResponse() = 
        member val InsertedId:Int32 = new Int32() with get,set
        member val Code:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentElement() = 
        member val Id:Int32 = new Int32() with get,set
        member val TemplateId:Int32 = new Int32() with get,set
        [<Required>]
        member val ElementKey:String = null with get,set

        [<Required>]
        member val Tag:String = null with get,set

        member val ParentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<Required>]
        member val Title:String = null with get,set

        member val Description:String = null with get,set
        [<Required>]
        member val DataType:String = null with get,set

        member val TemplateType:String = null with get,set
        member val OrderIndex:Int32 = new Int32() with get,set
        member val IsRequired:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type DocumentElementDto() = 
        inherit DocumentElement()
        member val Children:ResizeArray<DocumentElementDto> = new ResizeArray<DocumentElementDto>() with get,set

    [<AllowNullLiteral>]
    type CreateOrUpdateTemplateRequest() = 
        member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DocumentIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val Elements:ResizeArray<DocumentElementDto> = new ResizeArray<DocumentElementDto>() with get,set

F# CreateOrUpdateTemplateRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /document-template HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"documentIds":[0],"title":"String","description":"String","isActive":false,"elements":[{"children":[{"children":[{"children":null,"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"insertedId":0,"code":0,"message":"String"}