tvpl.api

<back to all web services

AuditLogRequest

Requires Authentication
The following routes are available for this service:
GET/audits
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

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class AuditLogRequest
            Inherits PagingRequest
            Public Overridable Property UserName As String
            Public Overridable Property UserId As Integer
            Public Overridable Property DocumentId As Integer
            Public Overridable Property Action As String
            Public Overridable Property Description As String
            Public Overridable Property IpAddress As String
            Public Overridable Property StartDate As Date
            Public Overridable Property EndDate As Date
        End Class

        Public Partial Class PageResponse(Of AuditLog)
            Implements IResponseRequest
            Public Sub New()
                Data = New List(Of AuditLog)
            End Sub

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

        Public Partial Class Pagination
            Public Overridable Property Total As Long
            Public Overridable Property Pages As Integer
            Public Overridable Property Offset As Long
            Public Overridable Property Limit As Integer
            Public Overridable Property CurrentPage As Integer
        End Class

        Public Partial Class PagingRequest
            Public Overridable Property Page As Integer
            Public Overridable Property Limit As Integer
        End Class
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class AuditLog
            Inherits MongoObject
            Implements IEntityId
            Implements ICreated
            Implements IUpdate
            Public Overridable Property UserName As String
            Public Overridable Property UserId As Nullable(Of Integer)
            Public Overridable Property DocumentId As Integer
            Public Overridable Property Action As String
            Public Overridable Property Description As String
            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As Date
            Public Overridable Property IpAddress As String
            Public Overridable Property UserAgent As String
        End Class

        Public Partial Class MongoObject
            Implements IMongoModel
            Public Overridable Property Id As String
        End Class
    End Namespace
End Namespace

VB.NET AuditLogRequest 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.

GET /audits HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			userName: String,
			userId: 0,
			documentId: 0,
			action: String,
			description: String,
			ipAddress: String,
			userAgent: String,
			id: 000000000000000000000000
		}
	]
}