tvpl.api

<back to all web services

SearchCategoryRequest

Requires Authentication
The following routes are available for this service:
POST/category
namespace tvpl.api.ServiceModel

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

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

    [<AllowNullLiteral>]
    type CategoryRequest() = 
        member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Type:Nullable<CategoryTypes> = new Nullable<CategoryTypes>() with get,set
        member val Name:String = null with get,set
        member val ParentId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type SearchCategoryRequest() = 
        inherit CategoryRequest()

    [<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 Category() = 
        inherit CreateCategoryModel()
        member val Id:Int32 = new Int32() with get,set
        member val Level:Int32 = new Int32() with get,set
        member val SortOrder:Int32 = new Int32() with get,set
        member val LastUpdate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        [<Ignore>]
        member val Children:ResizeArray<Category> = new ResizeArray<Category>() with get,set

    [<AllowNullLiteral>]
    type BaseResponse<List>() = 
        member val Code:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val Data:ResizeArray<Category> = new ResizeArray<Category>() with get,set

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