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.*


open class SearchCategoryRequest : CategoryRequest()
{
}

open class CategoryRequest
{
    var id:Int? = null
    @SerializedName("type") var Type:CategoryTypes? = null
    var name:String? = null
    var parentId:Int? = null
}

enum class CategoryTypes
{
    Department,
    PartyGroup,
    DocGroup,
    DocType,
    IssuingAgency,
    Status,
    Subjects,
    Workflow,
}

open class BaseResponse<List> : IResponseRequest
{
    var code:Int? = null
    var message:String? = null
    @SerializedName("data") var Data:ArrayList<Category> = ArrayList<Category>()
}

open class Category : CreateCategoryModel()
{
    var id:Int? = null
    var level:Int? = null
    var sortOrder:Int? = null
    var lastUpdate:Date? = null
    @Ignore()
    var children:ArrayList<Category> = ArrayList<Category>()
}

open class CreateCategoryModel
{
    var name:String? = null
    var description:String? = null
    @SerializedName("type") var Type:CategoryTypes? = null
    var isParty:Boolean? = null
    @Ignore()
    var childList:ArrayList<Int> = ArrayList<Int>()
}

Kotlin 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
			]
		}
	]
}