tvpl.api

<back to all web services

AuditLogRequest

Requires Authentication
The following routes are available for this service:
GET/audits
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagingRequest:
    page: int = 0
    limit: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MongoObject(IMongoModel):
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuditLog(MongoObject, IEntityId, ICreated, IUpdate):
    user_name: Optional[str] = None
    user_id: Optional[int] = None
    document_id: int = 0
    action: Optional[str] = None
    description: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
    ip_address: Optional[str] = None
    user_agent: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuditLogRequest(PagingRequest):
    user_name: Optional[str] = None
    user_id: int = 0
    document_id: int = 0
    action: Optional[str] = None
    description: Optional[str] = None
    ip_address: Optional[str] = None
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Pagination:
    total: int = 0
    pages: int = 0
    offset: int = 0
    limit: int = 0
    current_page: int = 0


AuditLog = TypeVar('AuditLog')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PageResponse(Generic[AuditLog], IResponseRequest):
    code: int = 0
    message: Optional[str] = None
    data: Optional[List[AuditLog]] = None
    pagination: Optional[Pagination] = None

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