tvpl.api

<back to all web services

SearchDocumentReferenceRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
GET/document-reference/search
SearchDocumentReferenceRequest Parameters:
NameParameterData TypeRequiredDescription
DocumentCodequerystringYes
ParentDocumentIdqueryint?No
TitlequerystringYes
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-reference/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,
			parentDocumentId: 0,
			title: String,
			documentCode: String,
			referenceUrl: String,
			description: String
		}
	]
}