tvpl.api

<back to all web services

SearchCategoryRequest

Requires Authentication
The following routes are available for this service:
POST/category
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceModel
Imports tvpl.data.Models
Imports tvpl.data.Constant

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class BaseResponse(Of List)
            Implements IResponseRequest
            Public Sub New()
                Data = New List(Of Category)
            End Sub

            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
            Public Overridable Property Data As List(Of Category)
        End Class

        Public Partial Class SearchCategoryRequest
            Inherits CategoryRequest
        End Class
    End Namespace

    Namespace tvpl.data.Constant

        Public Enum CategoryTypes
            Department
            PartyGroup
            DocGroup
            DocType
            IssuingAgency
            Status
            Subjects
            Workflow
        End Enum
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class Category
            Inherits CreateCategoryModel
            Public Sub New()
                Children = New List(Of Category)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property Level As Integer
            Public Overridable Property SortOrder As Integer
            Public Overridable Property LastUpdate As Nullable(Of Date)
            <Ignore>
            Public Overridable Property Children As List(Of Category)
        End Class

        Public Partial Class CategoryRequest
            Public Overridable Property Id As Nullable(Of Integer)
            Public Overridable Property Type As Nullable(Of CategoryTypes)
            Public Overridable Property Name As String
            Public Overridable Property ParentId As Nullable(Of Integer)
        End Class

        Public Partial Class CreateCategoryModel
            Public Sub New()
                ChildList = New List(Of Integer)
            End Sub

            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Type As CategoryTypes
            Public Overridable Property IsParty As Boolean
            <Ignore>
            Public Overridable Property ChildList As List(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET 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
			]
		}
	]
}