tvpl.api

<back to all web services

SearchDocumentNumberFormatRequest

Requires Authentication
The following routes are available for this service:
GET/document-number-format/search
SearchDocumentNumberFormatRequest Parameters:
NameParameterData TypeRequiredDescription
NamequerystringNo
TypeKeyquerystringNo
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
PageResponse<AuditLog> Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformList<AuditLog>Yes
PaginationformPaginationYes
AuditLog Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNo
UserIdformint?No
DocumentIdformintNo
ActionformstringYes
DescriptionformstringYes
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo
IpAddressformstringNo
UserAgentformstringNo
MongoObject Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
TotalformlongNo
PagesformintNo
OffsetformlongNo
LimitformintNo
CurrentPageformintNo

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 /document-number-format/search 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: 
	[
		{
			id: 0,
			typeKey: String,
			name: String,
			formatTemplate: String,
			padding: 0,
			resetPeriod: 0,
			labelKeys: String,
			isActive: False,
			isDeleted: False,
			deletedAt: "0001-01-01T00:00:00.0000000+07:06",
			deletedBy: 0,
			createdAt: "0001-01-01T00:00:00.0000000+07:06",
			createdBy: 0,
			updatedAt: "0001-01-01T00:00:00.0000000+07:06",
			updatedBy: 0
		}
	]
}