tvpl.api

<back to all web services

SearchCategoryRequest

Requires Authentication
The following routes are available for this service:
POST/category
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class SearchCategoryRequest extends CategoryRequest
    {
        
    }

    public static class CategoryRequest
    {
        public Integer id = null;
        public CategoryTypes type = null;
        public String name = null;
        public Integer parentId = null;
        
        public Integer getId() { return id; }
        public CategoryRequest setId(Integer value) { this.id = value; return this; }
        public CategoryTypes getType() { return type; }
        public CategoryRequest setType(CategoryTypes value) { this.type = value; return this; }
        public String getName() { return name; }
        public CategoryRequest setName(String value) { this.name = value; return this; }
        public Integer getParentId() { return parentId; }
        public CategoryRequest setParentId(Integer value) { this.parentId = value; return this; }
    }

    public static enum CategoryTypes
    {
        Department,
        PartyGroup,
        DocGroup,
        DocType,
        IssuingAgency,
        Status,
        Subjects,
        Workflow;
    }

    public static class BaseResponse<List> implements IResponseRequest
    {
        public Integer code = null;
        public String message = null;
        public ArrayList<Category> data = null;
        
        public Integer getCode() { return code; }
        public BaseResponse<List> setCode(Integer value) { this.code = value; return this; }
        public String getMessage() { return message; }
        public BaseResponse<List> setMessage(String value) { this.message = value; return this; }
        public ArrayList<Category> getData() { return data; }
        public BaseResponse<List> setData(ArrayList<Category> value) { this.data = value; return this; }
    }

    public static class Category extends CreateCategoryModel
    {
        public Integer id = null;
        public Integer level = null;
        public Integer sortOrder = null;
        public Date lastUpdate = null;
        @Ignore()
        public ArrayList<Category> children = null;
        
        public Integer getId() { return id; }
        public Category setId(Integer value) { this.id = value; return this; }
        public Integer getLevel() { return level; }
        public Category setLevel(Integer value) { this.level = value; return this; }
        public Integer getSortOrder() { return sortOrder; }
        public Category setSortOrder(Integer value) { this.sortOrder = value; return this; }
        public Date getLastUpdate() { return lastUpdate; }
        public Category setLastUpdate(Date value) { this.lastUpdate = value; return this; }
        public ArrayList<Category> getChildren() { return children; }
        public Category setChildren(ArrayList<Category> value) { this.children = value; return this; }
    }

    public static class CreateCategoryModel
    {
        public String name = null;
        public String description = null;
        public CategoryTypes type = null;
        public Boolean isParty = null;
        @Ignore()
        public ArrayList<Integer> childList = null;
        
        public String getName() { return name; }
        public CreateCategoryModel setName(String value) { this.name = value; return this; }
        public String getDescription() { return description; }
        public CreateCategoryModel setDescription(String value) { this.description = value; return this; }
        public CategoryTypes getType() { return type; }
        public CreateCategoryModel setType(CategoryTypes value) { this.type = value; return this; }
        public Boolean getIsParty() { return isParty; }
        public CreateCategoryModel setIsParty(Boolean value) { this.isParty = value; return this; }
        public ArrayList<Integer> getChildList() { return childList; }
        public CreateCategoryModel setChildList(ArrayList<Integer> value) { this.childList = value; return this; }
    }

}

Java SearchCategoryRequest 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 HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SearchCategoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
  <Name xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Name>
  <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
  <Type xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">Department</Type>
</SearchCategoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BaseResponseOfArrayOfCategoryHRAGzk1w xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:Category>
      <d2p1:ChildList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:ChildList>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IsParty>false</d2p1:IsParty>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Type>Department</d2p1:Type>
      <d2p1:Children>
        <d2p1:Category>
          <d2p1:ChildList xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:ChildList>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:IsParty>false</d2p1:IsParty>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Type>Department</d2p1:Type>
          <d2p1:Children>
            <d2p1:Category>
              <d2p1:ChildList xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </d2p1:ChildList>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:IsParty>false</d2p1:IsParty>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Type>Department</d2p1:Type>
              <d2p1:Children i:nil="true" />
              <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
              <d2p1:CreatedBy>0</d2p1:CreatedBy>
              <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
              <d2p1:DeletedBy>0</d2p1:DeletedBy>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:IsDeleted>false</d2p1:IsDeleted>
              <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
              <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
              <d2p1:Level>0</d2p1:Level>
              <d2p1:SortOrder>0</d2p1:SortOrder>
            </d2p1:Category>
          </d2p1:Children>
          <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
          <d2p1:DeletedBy>0</d2p1:DeletedBy>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsDeleted>false</d2p1:IsDeleted>
          <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
          <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
          <d2p1:Level>0</d2p1:Level>
          <d2p1:SortOrder>0</d2p1:SortOrder>
        </d2p1:Category>
      </d2p1:Children>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
      <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
      <d2p1:Level>0</d2p1:Level>
      <d2p1:SortOrder>0</d2p1:SortOrder>
    </d2p1:Category>
  </Data>
  <Message>String</Message>
</BaseResponseOfArrayOfCategoryHRAGzk1w>