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
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;
using tvpl.data.Constant;

namespace tvpl.api.ServiceModel
{
    public partial class CreateCategoryRequest
        : CreateCategoryModel
    {
    }

    public partial class CreateCategoryResponse
        : IResponseRequest
    {
        public virtual long Id { get; set; }
        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
    }

}

namespace tvpl.data.Constant
{
    public enum CategoryTypes
    {
        Department,
        PartyGroup,
        DocGroup,
        DocType,
        IssuingAgency,
        Status,
        Subjects,
        Workflow,
    }

}

namespace tvpl.data.Models
{
    public partial class CreateCategoryModel
    {
        public CreateCategoryModel()
        {
            ChildList = new List<int>{};
        }

        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual CategoryTypes Type { get; set; }
        public virtual bool IsParty { get; set; }
        [Ignore]
        public virtual List<int> ChildList { get; set; }
    }

}

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