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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	type: Department,
	name: String,
	parentId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			id: 0,
			level: 0,
			sortOrder: 0,
			lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
			children: 
			[
				{
					id: 0,
					level: 0,
					sortOrder: 0,
					lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
					children: 
					[
						{
							id: 0,
							level: 0,
							sortOrder: 0,
							lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
							name: String,
							description: String,
							type: Department,
							isParty: False,
							childList: 
							[
								0
							]
						}
					],
					name: String,
					description: String,
					type: Department,
					isParty: False,
					childList: 
					[
						0
					]
				}
			],
			name: String,
			description: String,
			type: Department,
			isParty: False,
			childList: 
			[
				0
			]
		}
	]
}