tvpl.api

<back to all web services

CreateCategoryRequest

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

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

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

    type CategoryTypes =
        | Department = 0
        | PartyGroup = 1
        | DocGroup = 2
        | DocType = 3
        | IssuingAgency = 4
        | Status = 5
        | Subjects = 6
        | Workflow = 7

    [<AllowNullLiteral>]
    type CreateCategoryModel() = 
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Type:CategoryTypes = new CategoryTypes() with get,set
        member val IsParty:Boolean = new Boolean() with get,set
        [<Ignore>]
        member val ChildList:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

    [<AllowNullLiteral>]
    type CreateCategoryRequest() = 
        inherit CreateCategoryModel()

F# CreateCategoryRequest 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 /category/create HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCategoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <ChildList 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>
  </ChildList>
  <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
  <IsParty xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsParty>
  <Name xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Name>
  <Type xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">Department</Type>
</CreateCategoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCategoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Id>0</Id>
  <Message>String</Message>
</CreateCategoryResponse>