tvpl.api

SearchCategoryRequest

The following routes are available for this service:
POST	/category


export enum CategoryTypes
{
    Department = 'Department',
    PartyGroup = 'PartyGroup',
    DocGroup = 'DocGroup',
    DocType = 'DocType',
    IssuingAgency = 'IssuingAgency',
    Status = 'Status',
    Subjects = 'Subjects',
    Workflow = 'Workflow',
}

export class CategoryRequest
{
    public id?: number;
    public type?: CategoryTypes;
    public name?: string;
    public parentId?: number;

    public constructor(init?: Partial<CategoryRequest>) { (Object as any).assign(this, init); }
}

export class SearchCategoryRequest extends CategoryRequest
{

    public constructor(init?: Partial<SearchCategoryRequest>) { super(init); (Object as any).assign(this, init); }
}

export class CreateCategoryModel
{
    public name: string;
    public description: string;
    public type: CategoryTypes;
    public isParty: boolean;
    // @Ignore()
    public childList?: number[];

    public constructor(init?: Partial<CreateCategoryModel>) { (Object as any).assign(this, init); }
}

export class Category extends CreateCategoryModel
{
    public id: number;
    public level: number;
    public sortOrder: number;
    public lastUpdate?: string;
    // @Ignore()
    public children: Category[];

    public constructor(init?: Partial<Category>) { super(init); (Object as any).assign(this, init); }
}

export class BaseResponse<any[]> implements IResponseRequest
{
    public code: number;
    public message?: string;
    public data?: Category[];

    public constructor(init?: Partial<BaseResponse<any[]>>) { (Object as any).assign(this, init); }
}

TypeScript 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>