tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search
SearchTemplateRequest Parameters:
NameParameterData TypeRequiredDescription
TitlequerystringNo
IsActivequerybool?No
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
SearchDocumentTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformList<DocumentTemplate>No
TotalCountformlongNo
DocumentTemplate Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringYes
DescriptionformstringNo
IsActiveformboolNo
FileKeyformstringNo
FileUrlformstringNo
FileNameformstringNo
FileSizeformlong?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /document-template/search HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchDocumentTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentTemplate>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FileKey>String</d2p1:FileKey>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>0</d2p1:FileSize>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:DocumentTemplate>
  </Data>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
</SearchDocumentTemplateResponse>